docs: escape tcp daemon address in docstring to prevent broken link - #494
Open
reginaldalfret wants to merge 1 commit into
Open
reginaldalfret wants to merge 1 commit into
reginaldalfret wants to merge 1 commit into
Conversation
Wrap daemon address examples in inline code literals (`) in DaemonConfig class docstring so Sphinx does not treat the tcp: notation as an external hyperlink scheme. Fixes aws#286 Signed-off-by: reginaldalfret <reginaldalfret@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Fixes #286
Description of changes:
In �ws_xray_sdk/core/daemon_config.py, wrap the daemon address examples in inline code literals (`) in the DaemonConfig docstring. This prevents Sphinx from interpreting 'tcp:127.0.0.1:2000' as an external URL scheme when building HTML documentation.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.